All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.pluginapi.JPluginFrame

Object
   |
   +----Component
           |
           +----Container
                   |
                   +----Window
                           |
                           +----Frame
                                   |
                                   +----EmbeddedFrame
                                           |
                                           +----WEmbeddedFrame
                                                   |
                                                   +----BasePluginWindow
                                                           |
                                                           +----BasePluginFrame
                                                                   |
                                                                   +----PluginFrame
                                                                           |
                                                                           +----com.symantec.itools.vcafe.openapi.pluginapi.JPluginFrame

public class JPluginFrame

extends PluginFrame

implements WindowConstants, RootPaneContainer

Version:

1.0

Author:

Symantec Internet Tools Division

Since:

VCafe 3.0

See Also:

PluginFrame

rootPane

The JRootPane instance that manages the contentPane and optional menuBar for this frame, as well as the glassPane.

rootPaneCheckingEnabled

If true then calls to add and setLayout cause an exception to be thrown.

com.symantec.itools.vcafe.openapi.pluginapi.JPluginFrame()

Constructs a new Frame that is initially invisible.

com.symantec.itools.vcafe.openapi.pluginapi.JPluginFrame(String)

Constructs a new, initially invisible Frame with the specified title.

addImpl(Component, Object, int)

By default, children may not be added directly to a this component, they must be added to its contentPane instead.

createRootPane()

Called by the constructor methods to create the default rootPane.

frameInit()

Called by the constructors to init the JPluginFrame properly.

getContentPane()

Returns the contentPane object for this frame.

getDefaultCloseOperation()

Returns the operation which occurs when the user initiates a "close" on this frame.

getGlassPane()

Returns the glassPane object for this frame.

getLayeredPane()

Returns the layeredPane object for this frame.

getRootPane()

Returns the rootPane object for this frame.

isRootPaneCheckingEnabled()

Returns whether calls to add and setLayout cause an exception to be thrown.

processKeyEvent(KeyEvent)

Processes key events occurring on this component and, if appropriate, passes them on to components in the frame which have registered interest in them.

processWindowEvent(WindowEvent)

Processes window events occurring on this component.

setContentPane(Container)

Sets the contentPane property.

setDefaultCloseOperation(int)

Sets the operation which will happen by default when the user initiates a "close" on this frame.

setGlassPane(Component)

Sets the glassPane property.

setLayeredPane(JLayeredPane)

Sets the layeredPane property.

setLayout(LayoutManager)

By default the layout of this component may not be set, the layout of its contentPane should be set instead.

setRootPane(JRootPane)

Sets the rootPane property.

setRootPaneCheckingEnabled(boolean)

Determines whether calls to add and setLayout cause an exception to be thrown.

update(Graphics)

Just calls paint(g).

protected com.sun.java.swing.JRootPane rootPane

The JRootPane instance that manages the contentPane and optional menuBar for this frame, as well as the glassPane.

See Also:

JRootPane, RootPaneContainer

protected boolean rootPaneCheckingEnabled

If true then calls to add and setLayout cause an exception to be thrown.

See Also:

isRootPaneCheckingEnabled, setRootPaneCheckingEnabled

public JPluginFrame()

Constructs a new Frame that is initially invisible.

See Also:

setSize, setVisible

public JPluginFrame(String title)

Constructs a new, initially invisible Frame with the specified title.

Parameters:

title - the title for the frame

See Also:

setSize, setVisible

protected void addImpl(Component comp,
                       Object constraints,
                       int index)

By default, children may not be added directly to a this component, they must be added to its contentPane instead. For example:

 thisComponent.getContentPane().add(child)
 

An attempt to add to directly to this component will cause an runtime exception to be thrown. Subclasses can disable this behavior.

Throws: Error

if called with rootPaneChecking true

Overrides:

addImpl in class Container

See Also:

setRootPaneCheckingEnabled

protected com.sun.java.swing.JRootPane createRootPane()

Called by the constructor methods to create the default rootPane.

protected void frameInit()

Called by the constructors to init the JPluginFrame properly.

public java.awt.Container getContentPane()

Returns the contentPane object for this frame.

See Also:

setContentPane, getContentPane

public int getDefaultCloseOperation()

Returns the operation which occurs when the user initiates a "close" on this frame.

Returns:

an int indicating the window-close operation

See Also:

setDefaultCloseOperation

public java.awt.Component getGlassPane()

Returns the glassPane object for this frame.

See Also:

setGlassPane, getGlassPane

public com.sun.java.swing.JLayeredPane getLayeredPane()

Returns the layeredPane object for this frame.

See Also:

setLayeredPane, getLayeredPane

public com.sun.java.swing.JRootPane getRootPane()

Returns the rootPane object for this frame.

See Also:

setRootPane, getRootPane

protected boolean isRootPaneCheckingEnabled()

Returns whether calls to add and setLayout cause an exception to be thrown.

Returns:

true if add and setLayout are checked

See Also:

addImpl, setLayout, setRootPaneCheckingEnabled

protected void processKeyEvent(KeyEvent e)

Processes key events occurring on this component and, if appropriate, passes them on to components in the frame which have registered interest in them.

Parameters:

e - the key event

Overrides:

processKeyEvent in class BasePluginWindow

See Also:

processKeyEvent

protected void processWindowEvent(WindowEvent e)

Processes window events occurring on this component. Hides the window or disposes of it, as specified by the setting of the defaultCloseOperation property.

Parameters:

e - the window event

Overrides:

processWindowEvent in class Window

See Also:

setDefaultCloseOperation, processWindowEvent

public void setContentPane(Container contentPane)

Sets the contentPane property. This method is called by the constructor.

Parameters:

contentPane - the contentPane object for this frame

Throws: IllegalComponentStateException

(a runtime exception) if the content pane parameter is null

See Also:

getContentPane, setContentPane

public void setDefaultCloseOperation(int operation)

Sets the operation which will happen by default when the user initiates a "close" on this frame. The possible choices are:

• DO_NOTHING_ON_CLOSE - do not do anything - require the program to handle the operation in the windowClosing method of a registered WindowListener object.
• HIDE_ON_CLOSE - automatically hide the frame after invoking any registered WindowListener objects
• DISPOSE_ON_CLOSE - automatically hide and dispose the frame after invoking any registered WindowListener objects

The value is set to HIDE_ON_CLOSE by default.

See Also:

addWindowListener, getDefaultCloseOperation

public void setGlassPane(Component glassPane)

Sets the glassPane property. This method is called by the constructor.

Parameters:

glassPane - the glassPane object for this frame

See Also:

getGlassPane, setGlassPane

public void setLayeredPane(JLayeredPane layeredPane)

Sets the layeredPane property. This method is called by the constructor.

Parameters:

layeredPane - the layeredPane object for this frame

Throws: IllegalComponentStateException

(a runtime exception) if the layered pane parameter is null

See Also:

getLayeredPane, setLayeredPane

public void setLayout(LayoutManager manager)

By default the layout of this component may not be set, the layout of its contentPane should be set instead. For example:

 thiComponent.getContentPane().setLayout(new BorderLayout())
 

An attempt to set the layout of this component will cause an runtime exception to be thrown. Subclasses can disable this behavior.

Throws: Error

if called with rootPaneChecking true

Overrides:

setLayout in class Container

See Also:

setRootPaneCheckingEnabled

protected void setRootPane(JRootPane root)

Sets the rootPane property. This method is called by the constructor.

Parameters:

root - the rootPane object for this frame

See Also:

getRootPane

protected void setRootPaneCheckingEnabled(boolean enabled)

Determines whether calls to add and setLayout cause an exception to be thrown.

Parameters:

enabled - a boolean value, true if checking is to be enabled, which cause the exceptions to be thrown

See Also:

addImpl, setLayout, isRootPaneCheckingEnabled

public void update(Graphics g)

Just calls paint(g). This method was overridden to prevent an unneccessary call to clear the background.

Parameters:

g - the Graphics context in which to paint

Overrides:

update in class BasePluginWindow

All Packages  Class Hierarchy  This Package  Previous  Next  Index